/*
 * File:    SchedulerInterface.java
 * Created: 20-Oct-2006
 *
 * by Kenji Hollis <kenji@bitgatesoftware.com>
 * Released under the Creative Commons License version 2.5
 */

package com.bitgate.util.scheduler;

/**
 * This is a scheduling interface, used to tell the <code>Scheduler</code> class that a function can be triggered using a
 * standard interface entry point.
 *
 * @author Kenji Hollis &lt;kenji@bitgatesoftware.com&gt;
 * @since 0.1
 */
public interface SchedulerInterface
{
    /**
     * This is the function that is called when the function inside the class to be scheduled is run.
     */
    void trigger();

    /**
     * Retrieves the name of the registered task in the scheduled class.
     *
     * @return <code>String</code> containing the name of the class.
     */
    String getTaskName();
}
